Get a business details by ID

GET /api/v1/Businesses/:id/get

Description

This endpoint allows you to retrieve details of a specific business based on its unique identifier.

Request

• Path: /api/v{version}/Businesses/{id}/get
• Headers:
  • Accept-Language: Change default response message language from English(en). Available languages fr,en
• Parameters:
  • id (path): Unique identifier of the business.
  • version (path): API version.
• Response: GetBusinessResponseResponse

Response Examples

Success (200):

httpCopy codeHTTP/1.1 200 OK
{
  "id": "123",
  "name": "Sample Business",
  "email": "business@example.com",
  "phone": "123456789",
  "address": "123 Example St., Exampleville, EX, 12345"
}

/api/v`{{version}}`/Businesses/:id/get

Headers

Content-Type	Value
Accept-Language

Headers

Content-Type	Value
Accept	text/plain

Response: 200

{
  "succeeded": <boolean>,
  "message": <string>,
  "errors": [
    <string>,
    <string>
  ],
  "data": {
    "address": {
      "addressLine1": <string>,
      "addressLine2": <string>,
      "state": <string>,
      "city": <string>,
      "zipCode": <string>
    },
    "id": <uuid>,
    "userId": <uuid>,
    "tenantId": <uuid>,
    "name": <string>,
    "incorporationDate": <dateTime>,
    "industry": <string>,
    "mobileNumber": <string>,
    "countryOfIncorporation": <string>,
    "incorporationType": <string>,
    "incorporationNumber": <string>,
    "websiteUrl": <string>,
    "termsAndConditionsSignedAt": <dateTime>,
    "clientId": <integer>
  }
}